Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d10 / uplot20b.arc / UPLOT.DOC < prev next >

Wrap

Text File | 1990-10-05 | 18KB | 595 lines

UPLOT(C) v2.0 DOCUMENTATION (Shareware package) BY: Roy L. Lung October 5, 1990 2055 Mill Road Mechanicsville, MD 20659 (301) 884-4766 voice (301) 884-8549 KEEPASM BBS HST 9600/2400/1200/300 BAUD 8-N-1 UPLOT(C) - Universal Plotting Program COPYRIGHT (C) 1990 by Roy L. Lung, ALL RIGHTS RESERVED. Support on KEEPASM - BBS You should have the following files: README .NOW = MUST read text file INSTALL.EXE = Sets up UPLOT.DAT UPLOT .DOC = THIS document file UPLOT .EXE = Universal plotting program UPLOT .HLP = UPLOT(C) help file STUPLOT.BAT = Easy operation file DEMO .BAT = Quick demonstration PLOT1 .PLT = Sample plots PLOT2 .PLT = Sample plots PLOT3 .PLT = Sample plots STICK .EXE = Collect Joystick Data MODE2 .DAT = Used by INSTALL.EXE MODE3 .DAT = Used by INSTALL.EXE MODE4 .DAT = Used by INSTALL.EXE MODE8 .DAT = Used by INSTALL.EXE MODE9 .DAT = Used by INSTALL.EXE MODEK .DAT = Used by INSTALL.EXE MODEL .DAT = Used by INSTALL.EXE MODEM .DAT = Used by INSTALL.EXE To get started: 1. Copy all these files to a Subdirectory of your choice. [ suggest: \UPLOT ] To make the new directory enter: MD \UPLOT Enter: COPY A:\*.* C:\UPLOT {if file are on A: drive} 2. Change your directory to the default: \UPLOT Enter: CD \UPLOT 3. Next to read the README.NOW text file with your text editor. Follow the instruction included with the editor. Skip step 4 to speed up getting started. 4. To print the README.NOW, enter: "PRINT README.NOW" at your DOS prompt. 5. Read the printed README.NOW file! 6. Run the demonstration batch file by entering: DEMO Read the text and instructions in it carefully! 7. To see the command line format of either STICK(C) or UPLOT(C) just enter their name at the DOS command line. [ STICK ] or [ UPLOT ] 8. Read the batch files included with the files. They will help you understand the command line requirements - this will help you when your ready to make your own customized batch files. The following is a list of keys and their function when using UPLOT(C): <Right Arrow> = Move index right - or only actives the index line to be displayed if it is the first time a index positioning key has been pressed. Holding the arrow key down will invoke rapid movement to quickly get to the new position desired (also see the key). <Left Arrow> = Move index left - or only actives the index line to be displayed if it is the first time a index positioning key has been pressed. Holding the arrow key down will invoke rapid movement to quickly get to the new position desired (also see the key). <Up Arrow> = Limits info back - the limits information line will display the peaks and lowest data values in your plot file and even place a marker for its position in the plot box and give its offset into the data file on the top of the plot box. The data values of the other plots at that position are also shown. <Down Arrow> = Limits info forward (see <Up Arrow> description) <Home Key> = Moves the index to the beginning of the plot screen. (the position of the index into the plot data is updated top-right of the plot window box) <End Key> = Moves the index to the end of the plot screen. (the position of the index into the plot data is updated top-right of the plot window box) <ESC>=escape = Exit plotting program - returns to system. <PAGE UP> = Magnifies active plots - this is a rescaling of the data of the active plots and will cause the plots to be redrawn. <PAGE DOWN> = Reduces active plots - the opposite of <PAGE UP> key. NOTE: Page up/dn will only affect scaling amplitude of currently active plots and will redraw active plots. <1> = Plot x1 toggle - you will see the current state of this flag in the upper right section of the screen. (see note below) <2> = Plot y1 toggle <3> = Plot x2 toggle <4> = Plot y2 toggle <5> = Plot TIME STAMP toggle NOTE: <1>-<5> only show affect on redraw; upper right corner of your screen will show current state of the plot toggles - 0 = off, 1 = on. The first active plot scale is displayed on the right of the plot box - to see other plot scales and disable the displaying of undesired plots then you must deactivate the plots before it - i.e. plots x1,y1,x2 are currently displayed so to see x2's scale and plot alone press <1> and <2> then <F2> to redraw screen. [new scale will be for x2] or = Sets the beginning of a new window at the current index position. The ending position must also be set before the new window can be displayed. <C> or <c> = Moves the index to the center of the current plot window. (the position of the index into the plot data is updated top-right of the plot window box) <E> or <e> = Window ends at index - sets the ending position of a new window and causes the new window to be displayed (activates window). <H> or <h> = Invokes a help window with the information needed for remembering the commands and registration information. <F1> is same. or = Set index position manually - a prompt will appear on the last line of the screen. Enter the new position to place the index line. If the position is less than the first plot point in the current window then it will be moved to the home position. If past the end of the current window then it will be placed at the last position on the current window. (the position of the index into the plot data is updated top-right of the plot window box) <L> or <l> = Plot by line toggle - the plotting can be by points or by drawing lines between the points. The screen will be redrawn. The line plotting mode can be very useful when the points have much change in amplitude between them or when looking for peaks/valleys. <N> or <n> = New plot - restarts allowing a new plot name to be entered for loading. You may only load new plots with the same number of data fields - i.e. if the new plot has a time stamp and the old one did not then the results of the plots will be invalid or cause a loading error! To plot a different type of plot you must restart UPLOT(C) entering the proper information as prompted or in the command line. To see the command line format - key in <UPLOT> at the DOS command line. or = Print the plot screen - you will be prompted for the type of printout desired. If your printer has a narrow carriage you should not select the wide type printouts! You can redirect the printout to a file for multiple printing or transfer to a system with a printer desired for the printing. The function keys <F3> - <F10> will help you remove unwanted information from the screen before you select this printing feature. NOTE: Print feature only available with registered versions! <S> or <s> = Sound toggle (ON/OFF) - toggle sound off if you dislike the beeping on errors or prompts. <T> or <t> = Text entry for customizing screen information by user - use it to label individual plots or enter other important captions. <W> or <w> = Window toggle - switches between full screen and a smaller view screen of plot data. This feature can be very useful for viewing details. <Z> or <z> = Zoom set window - a manual entry method for setting beginning and ending window positions. <F1> = Same as <H> key. <F2> = redraw plot - removes index line marker from display and removes limit line markers (except the last active limit). This has the effect of cleaning up the screen. <F3> = Clock display toggle - turns on or off the display of the clock in the upper right corner of the screen. The Clock line includes S=*### for the amount of programs internal stack memory. If TSR's are corrupting the stack you will see the number changing greatly. Some changes are expected as different routines within UPLOT(C) are executed and this is normal. The M=####K lets you tell the amount of free memory available to your system for other purposes or larger plot files. If this number is less than 5K you should increase the amount of available memory in the window for execution of UPLOT(C) or reduce the size of the plots to be displayed. <F4> = File name display toggle - allows the removal of the active plots path (if different than default) and files name from being displayed on the screen. <F5> = Minimum/Maximum screen ranges of currently displayed plot window toggle. (removes it from being displayed) <F6> = Time stamp display toggle (removes it from being displayed) <F7> = Amplitude multiplier display toggle (removes it from being displayed) <F8> = Amplitude scale display toggle (removes it from being displayed) This is the scale on the right of the plot. <F9> = Relative position scale toggle (removes it from being displayed) This is the scale on the bottom of the plot. <F10> = Amplitude weight scale display toggle (removes it from being displayed) This is the scale on the right of the plot. Supplemental information: You can not hurt anything by trying the different keys to see their response so feel free to experiment. The worst that could happen is for UPLOT(C) to abort with an error message. All fatal errors should be recorded in a file named UPLOT.ERR which can be deleted or uploaded to KEEPASM - BBS when you desire for me to look into the trouble. Also include a description of your problem and all data files affected (plots of your own). Tips: If you want to magnify only one plot and leave the others the same, then deactivate all but the plot to be affected (see help on keys 1 - 5). Use the <PAGE UP> key till it is at the desired magnification. After reactivating the other plots use the <F2> key to force a redraw of the plots. The magnification will remain in effect till de-magnified with the <PAGE DN> key. Still remember - ALL active plots are affected by the <PAGE UP/DN> keys! The keys that will affect STICK(C) will be displayed when you run the program allowing the display mode to be ON. The maximum speed of sampling the Joystick ports will depend on your system speed and whether or not you have set the sample count and allowed displaying of the stick data real-time. The program will not allow a sampling speed less than ONE Millisecond and you would have to have a very fast system to actually attain that rate. My PC/AT system would peak at about TWO Milliseconds! In actuality a speed of 20-50 Milliseconds is ample to track the patterns. The combination of STICK(C) with UPLOT(C) makes a good tester for your joysticks also! You can look for jumping or spiking of the sample data to see if you have a faulty potentiometer on one of the axis (It may also show up as a flat spot). STICK(C) can also show the activity of the joystick buttons when used in the slow speed mode (not setting the sample rate). UPLOT(C) can display up to 5 plots at the same time. The last of these is used for time stamping. The maximum number of plot points UPLOT(C) can handle will vary with your system memory, depth of samples, size of each sample, and whether Time Stamping is used. The maximum including Time Stamping is 278,228 unique plot points! The maximum number of plot points per axis is 65,476 in byte mode (16,324 if Time Stamping is included). This number should be more than adequate for most any plot data file that would be expected to be used on a "in memory mode" PC platform. Only a "file mode" could handle larger number of plot points but the speed would be much slower. A future registered version might include this feature. If you have a need for plotting larger files, please let me know and I will probably work on it. If you have a special application for which you would like a customized version of UPLOT(C), please let me know also! I will charge reasonable rates with the understanding that I could offer the program with future releases. REGISTERING: To receive a registered version of UPLOT(C) and STICK(C) please send a donation of $25.00 USA to: KEEPASM BBS Service Roy L. Lung 2055 Mill Road Mechanicsville, MD 20659 You will receive the latest version which will have (print) enabled for printing on Epson EX/FX-86e/FX-800 compatible and IBM Proprinter/Proprinter II and Citizen MSP-50/55 compatible IBM PC printers. Also more documentation which will include details on data file structure. This extra documentation will help you convert other plot data sources to be useable with UPLOT(C). To receive a copy of the source code for STICK(C) and UPLOT(C) please send a donation of $100.00 USA to the above address and request the source code be sent. Both STICK(C) and UPLOT(C) will work best when not used on a multitasking system. Having a color EGA or VGA screen will greatly improve both speed and usefulness. Also, speed can be greatly improved with the addition of a Math Co-Processor (8087 - 80387) in your system. If you desire additional printer interfaces or other features to be included in future versions - PLEASE send me a note with your registration. In the registered version more function keys will be used to control the screens displayed information to allow customizing printouts for presentations. PS If your system clock loses time while running STICK(C) a reboot will restore the time. [end of UPLOT.DOC]